public class ProtobufHttpMessageConverter extends AbstractHttpMessageConverter<Message>
HttpMessageConverter
that reads and writes com.google.protobuf.Message
s
using Google Protocol Buffers.
By default, it supports "application/x-protobuf"
, "text/plain"
,
"application/json"
, "application/xml"
, while also writing "text/html"
.
To generate Message
Java classes, you need to install the protoc
binary.
Requires Protobuf 2.6 and Protobuf Java Format 1.4, as of Spring 4.3.
Modifier and Type | Field and Description |
---|---|
static java.nio.charset.Charset |
DEFAULT_CHARSET |
private ExtensionRegistry |
extensionRegistry |
private static ProtobufFormatter |
HTML_FORMAT |
private static ProtobufFormatter |
JSON_FORMAT |
private static java.util.concurrent.ConcurrentHashMap<java.lang.Class<?>,java.lang.reflect.Method> |
methodCache |
static MediaType |
PROTOBUF |
static java.lang.String |
X_PROTOBUF_MESSAGE_HEADER |
static java.lang.String |
X_PROTOBUF_SCHEMA_HEADER |
private static ProtobufFormatter |
XML_FORMAT |
logger
Constructor and Description |
---|
ProtobufHttpMessageConverter()
Construct a new instance.
|
ProtobufHttpMessageConverter(ExtensionRegistryInitializer registryInitializer)
Construct a new instance with an
ExtensionRegistryInitializer
that allows the registration of message extensions. |
Modifier and Type | Method and Description |
---|---|
protected boolean |
canWrite(MediaType mediaType)
This method overrides the parent implementation, since this HttpMessageConverter
can also produce
MediaType.HTML "text/html" ContentType. |
protected MediaType |
getDefaultContentType(Message message)
Returns the default content type for the given type.
|
private static Message.Builder |
getMessageBuilder(java.lang.Class<? extends Message> clazz)
Create a new
Message.Builder instance for the given class. |
protected Message |
readInternal(java.lang.Class<? extends Message> clazz,
HttpInputMessage inputMessage)
Abstract template method that reads the actual object.
|
private void |
setProtoHeader(HttpOutputMessage response,
Message message)
Set the "X-Protobuf-*" HTTP headers when responding with a message of
content type "application/x-protobuf"
|
protected boolean |
supports(java.lang.Class<?> clazz)
Indicates whether the given class is supported by this converter.
|
protected void |
writeInternal(Message message,
HttpOutputMessage outputMessage)
Abstract template method that writes the actual body.
|
addDefaultHeaders, canRead, canRead, canWrite, getContentLength, getDefaultCharset, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write
public static final java.nio.charset.Charset DEFAULT_CHARSET
public static final MediaType PROTOBUF
public static final java.lang.String X_PROTOBUF_SCHEMA_HEADER
public static final java.lang.String X_PROTOBUF_MESSAGE_HEADER
private static final ProtobufFormatter JSON_FORMAT
private static final ProtobufFormatter XML_FORMAT
private static final ProtobufFormatter HTML_FORMAT
private static final java.util.concurrent.ConcurrentHashMap<java.lang.Class<?>,java.lang.reflect.Method> methodCache
private final ExtensionRegistry extensionRegistry
public ProtobufHttpMessageConverter()
public ProtobufHttpMessageConverter(ExtensionRegistryInitializer registryInitializer)
ExtensionRegistryInitializer
that allows the registration of message extensions.protected boolean supports(java.lang.Class<?> clazz)
AbstractHttpMessageConverter
supports
in class AbstractHttpMessageConverter<Message>
clazz
- the class to test for supporttrue
if supported; false
otherwiseprotected MediaType getDefaultContentType(Message message)
AbstractHttpMessageConverter
AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage)
is invoked without a specified content type parameter.
By default, this returns the first element of the
supportedMediaTypes
property, if any.
Can be overridden in subclasses.
getDefaultContentType
in class AbstractHttpMessageConverter<Message>
message
- the type to return the content type fornull
if not knownprotected Message readInternal(java.lang.Class<? extends Message> clazz, HttpInputMessage inputMessage) throws java.io.IOException, HttpMessageNotReadableException
AbstractHttpMessageConverter
AbstractHttpMessageConverter.read(java.lang.Class<? extends T>, org.springframework.http.HttpInputMessage)
.readInternal
in class AbstractHttpMessageConverter<Message>
clazz
- the type of object to returninputMessage
- the HTTP input message to read fromjava.io.IOException
- in case of I/O errorsHttpMessageNotReadableException
- in case of conversion errorsprotected boolean canWrite(MediaType mediaType)
MediaType.HTML "text/html"
ContentType.canWrite
in class AbstractHttpMessageConverter<Message>
mediaType
- the media type to write, can be null
if not specified.
Typically the value of an Accept
header.true
if the supported media types are compatible with the media type,
or if the media type is null
protected void writeInternal(Message message, HttpOutputMessage outputMessage) throws java.io.IOException, HttpMessageNotWritableException
AbstractHttpMessageConverter
AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage)
.writeInternal
in class AbstractHttpMessageConverter<Message>
message
- the object to write to the output messageoutputMessage
- the HTTP output message to write tojava.io.IOException
- in case of I/O errorsHttpMessageNotWritableException
- in case of conversion errorsprivate void setProtoHeader(HttpOutputMessage response, Message message)
Note: outputMessage.getBody()
should not have been called
before because it writes HTTP headers (making them read only).
private static Message.Builder getMessageBuilder(java.lang.Class<? extends Message> clazz) throws java.lang.Exception
Message.Builder
instance for the given class.
This method uses a ConcurrentHashMap for caching method lookups.
java.lang.Exception